/* @flow */

import Dep from './dep'
import VNode from '../vdom/vnode'
import { arrayMethods } from './array'
import {
  def,
  warn,
  hasOwn,
  hasProto,
  isObject,
  isPlainObject,
  isPrimitive,
  isUndef,
  isValidArrayIndex,
  isServerRendering
} from '../util/index'

const arrayKeys = Object.getOwnPropertyNames(arrayMethods)

/**
 * In some cases we may want to disable observation inside a component's
 * update computation.
 */
export let shouldObserve: boolean = true

export function toggleObserving (value: boolean) {
  shouldObserve = value
}

/**
 * Observer class that is attached to each observed
 * object. Once attached, the observer converts the target
 * object's property keys into getter/setters that
 * collect dependencies and dispatch updates.
 * 观察者类，会被附加到每个被观察的对象上 value.__ob__ = this
 * 而对象的各个属性则会被转换成setter/getter,并收集依赖和通知更新
 */
export class Observer {
  value: any;
  dep: Dep;
  vmCount: number; // number of vms that have this object as root $data

  constructor (value: any) {
    this.value = value
    //实例化一个dep
    this.dep = new Dep()
    this.vmCount = 0
    //在value对象上设置__ob__属性
    def(value, '__ob__', this)
    if (Array.isArray(value)) {
      /**
       * value为数组
       * hasProto = '__proto__' in {}
       * 用于判断对象是否存在__proto__属性，通过obj.__proto__可以访问对象的原型链
       * 但由于__proto__不是标准属性，有些浏览器不支持，IE6-10
       * 为什么要判断是因为一会要通过__proto__操作数组的原型链
       * 覆盖数组的默认7个原型方法，以实现数组响应式
       */
      if (hasProto) {
        protoAugment(value, arrayMethods)
      } else {
        copyAugment(value, arrayMethods, arrayKeys)
      }
      this.observeArray(value)
    } else {
      //为对象的每个属性包括嵌套对象设置响应式
      this.walk(value)
    }
  }

  /**
   * Walk through all properties and convert them into
   * getter/setters. This method should only be called when
   * value type is Object.
   * 遍历对象的每个key 为每个key设置响应式
   * 值为对象时才会执行这里
   */
  walk (obj: Object) {
    const keys = Object.keys(obj)
    for (let i = 0; i < keys.length; i++) {
      defineReactive(obj, keys[i])
    }
  }

  /**
   * Observe a list of Array items.
   * 比那里数组，为数组的每一项设置观察，并处理数组元素为对象的情况
   */
  observeArray (items: Array<any>) {
    for (let i = 0, l = items.length; i < l; i++) {
      observe(items[i])
    }
  }
}

// helpers

/**
 * Augment a target Object or Array by intercepting
 * the prototype chain using __proto__
 * 设置target.__proto__的原型对象为src
 * 比如数组对象 arr.__proto__ = arrayMethods
 */
function protoAugment (target, src: Object) {
  /* eslint-disable no-proto */
  target.__proto__ = src
  /* eslint-enable no-proto */
}

/**
 * Augment a target Object or Array by defining
 * hidden properties.
 * 在目标对象上定义指定属性
 * 比如数组，为数组对象定义那7个方法
 */
/* istanbul ignore next */
function copyAugment (target: Object, src: Object, keys: Array<string>) {
  for (let i = 0, l = keys.length; i < l; i++) {
    const key = keys[i]
    def(target, key, src[key])
  }
}

/**
 * Attempt to create an observer instance for a value,
 * returns the new observer if successfully observed,
 * or the existing observer if the value already has one.
 * 响应式处理真正的入口
 * 为对象创建观察者实例，如果对象已经被观察过，则返回该实例，否则创建新的观察者实例
 */
export function observe (value: any, asRootData: ?boolean): Observer | void {
  //非对象或VNode不做响应式处理
  if (!isObject(value) || value instanceof VNode) {
    return
  }
  let ob: Observer | void
  //如果value对象上存在__ob__属性表示已经做过观察了，直接返回__ob__属性
  if (hasOwn(value, '__ob__') && value.__ob__ instanceof Observer) {
    ob = value.__ob__
  } else if (
    shouldObserve &&
    !isServerRendering() &&
    (Array.isArray(value) || isPlainObject(value)) &&
    Object.isExtensible(value) &&
    !value._isVue
  ) {
    //创建新的观察者实例
    ob = new Observer(value)
  }
  if (asRootData && ob) {
    ob.vmCount++
  }
  return ob
}

/**
 * Define a reactive property on an Object.
 *
 */
/*
  拦截obj[key]的读取和设置操作：
    1、在第一次读取时收集依赖，比如执行render函数生成虚拟DOM时会有读取操作
    2、在更新时设置新值并通知依赖更新


*/
export function defineReactive (
  obj: Object,
  key: string,
  val: any,
  customSetter?: ?Function,
  shallow?: boolean
) {
  //实例化dep 一个key对应一个Dep
  const dep = new Dep()
  //判断属性描述符是否可可配置
  const property = Object.getOwnPropertyDescriptor(obj, key)
  if (property && property.configurable === false) {
    return
  }

  // cater for pre-defined getter/setters
  //记录getter/setter获取val值
  const getter = property && property.get
  const setter = property && property.set
  if ((!getter || setter) && arguments.length === 2) {
    val = obj[key]
  }
  // 递归调用，处理val为对象的时候，保证对象中所有的key都被观察到
  let childOb = !shallow && observe(val)
  //响应式的核心
  Object.defineProperty(obj, key, {
    enumerable: true,
    configurable: true,
    //get拦截obj[key]的读取操作
    get: function reactiveGetter () {
      const value = getter ? getter.call(obj) : val
      /**
       * Dep.target为Dep类的一个静态属性，值为watcher,在实例化Watcher时会被设置
       * 实例化Watcher时会执行 new Watcher()传递回调函数（computed除外因为它懒加载）
       * 而回调函数中如果有vm.key的读取操作,就会触发这里的读取拦截，进行依赖收集
       * 回调函数执行完成之后会执行  Dep.target = null,避免重复收集依赖
       *
       */
      if (Dep.target) {
        //依赖收集在dep中添加watcher，在watcher中添加dep
        dep.depend()
        //对象中嵌套对象，也对其进行依赖收集
        if (childOb) {
          //这一步就是为啥 this.ob.key1被更新时能触发响应式更新的原因
          childOb.dep.depend()
          //如果是数组则调用数组的响应式
          if (Array.isArray(value)) {
            //为数组的项为对象添加依赖
            dependArray(value)
          }
        }
      }
      return value
    },
    //set 拦截obj[key] 的设置操作
    set: function reactiveSetter (newVal) {
      const value = getter ? getter.call(obj) : val
      /* eslint-disable no-self-compare */
      //如果新老值一样，则直接return,不更新更不触发响应式更新过程
      if (newVal === value || (newVal !== newVal && value !== value)) {
        return
      }
      /* eslint-enable no-self-compare */
      if (process.env.NODE_ENV !== 'production' && customSetter) {
        customSetter()
      }
      // #7981: for accessor properties without setter
      //setter不存在说明属性是一个只读属性
      if (getter && !setter) return
      //设置新值
      if (setter) {
        setter.call(obj, newVal)
      } else {
        val = newVal
      }
      //对新值进行观察，让新值也是响应式
      childOb = !shallow && observe(newVal)
      //并依赖通知更新
      dep.notify()
    }
  })
}

/**
 * Set a property on an object. Adds the new property and
 * triggers change notification if the property doesn't
 * already exist.
 *
 * 通过Vue.set 或者this.$set 方法给target的指定key设置val
 * 如果 target 是对象，并且key原本不存在，则为key设置响应式，然后执行依赖通知
 *
 */
export function set (target: Array<any> | Object, key: any, val: any): any {
  if (process.env.NODE_ENV !== 'production' &&
    (isUndef(target) || isPrimitive(target))
  ) {
    warn(`Cannot set reactive property on undefined, null, or primitive value: ${(target: any)}`)
  }
  //更新数组制定下标的元素，Vue.set(arr,index,val) 通过splice方法来实现 响应式更新
  if (Array.isArray(target) && isValidArrayIndex(key)) {
    target.length = Math.max(target.length, key)
    target.splice(key, 1, val)
    return val
  }
  //更新对象已有属性，Vue.set(obj，key,val) 执行更新即可
  if (key in target && !(key in Object.prototype)) {
    target[key] = val
    return val
  }
  const ob = (target: any).__ob__
  //不能向Vue实例或者 $data 添加动态 响应式属性，vmCount 的用处之一，
  //this.$data 的 ob.vmCount = 1 表示根组件 其它子组件的vm.vmCount 都是0
  if (target._isVue || (ob && ob.vmCount)) {
    process.env.NODE_ENV !== 'production' && warn(
      'Avoid adding reactive properties to a Vue instance or its root $data ' +
      'at runtime - declare it upfront in the data option.'
    )
    return val
  }
  //如果target 不是响应式对象，新属性会被设置，但是不会做响应式处理  （TODO ？？？什么场景会出现？）
  if (!ob) {
    target[key] = val
    return val
  }
  //给对象定义新属性，通过defineReactive方法设置响应式，并触发依赖更新
  defineReactive(ob.value, key, val)
  ob.dep.notify()
  return val
}

/**
 * Delete a property and trigger change if necessary.
 * 通过Vue.delete 或者 vm.$delete 删除 target 对象指定的key
 *
 * 数组通过splice 方法实现 ，对象则通过 delete 运算符删除指定的key
 */
export function del (target: Array<any> | Object, key: any) {
  if (process.env.NODE_ENV !== 'production' &&
    (isUndef(target) || isPrimitive(target))
  ) {
    warn(`Cannot delete reactive property on undefined, null, or primitive value: ${(target: any)}`)
  }
  //目标是数组，则通过splice 方法删除指定下标的元素
  if (Array.isArray(target) && isValidArrayIndex(key)) {
    target.splice(key, 1)
    return
  }
  const ob = (target: any).__ob__
  //避免删除Vue的实例属性 或者 $data的数据
  if (target._isVue || (ob && ob.vmCount)) {
    process.env.NODE_ENV !== 'production' && warn(
      'Avoid deleting properties on a Vue instance or its root $data ' +
      '- just set it to null.'
    )
    return
  }
  //如果删除的属性不存在，直接结束
  if (!hasOwn(target, key)) {
    return
  }
  //通过delete 运算符删除对象的属性
  delete target[key]
  //不是响应式的key 直接结束
  if (!ob) {
    return
  }
  //执行依赖通知
  ob.dep.notify()
}

/**
 * Collect dependencies on array elements when the array is touched, since
 * we cannot intercept array element access like property getters.
 * 遍历每个数组对象，递归处理数组项为对象的情况，为其添加依赖
 * 因为前面递归阶段无法为数组中的对象元素添加依赖
 */
function dependArray (value: Array<any>) {
  for (let e, i = 0, l = value.length; i < l; i++) {
    e = value[i]
    e && e.__ob__ && e.__ob__.dep.depend()
    if (Array.isArray(e)) {
      dependArray(e)
    }
  }
}
